moved stack options to options/

diff --git a/gpsbabel/xmldoc/filters/options/stack-append.xml b/gpsbabel/xmldoc/filters/options/stack-append.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..eb4299e05ace74023f93e8a2741dd0c847f26024 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-append.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-append.xml
@@ -1 +1,5 @@
-
+<para>
+This option is only valid in conjunction with the <option>pop</option>.  
+When it is specified, the topmost collection of data from the stack is
+appended to the current collection of data.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-copy.xml b/gpsbabel/xmldoc/filters/options/stack-copy.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..ae9fe84490704770b823100fb51f1f5ab2103345 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-copy.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-copy.xml
@@ -1 +1,6 @@
-
+<para>
+This option is only valid when used with the <option>push</option> option.
+When this option is specified, a copy of the current state is pushed onto 
+the stack but the current state is left unchanged.  Otherwise, the push 
+operation clears the current data collection.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-depth.xml b/gpsbabel/xmldoc/filters/options/stack-depth.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..2103d5d59424076cee97a1dd6fed4bd9120f048c 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-depth.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-depth.xml
@@ -1 +1,6 @@
-
+<para>
+This option is only valid when used along with the <option>swap</option>
+option.  If specified, it indicates which item on the stack should be
+swapped with the current state.  The default value is 1, which corresponds
+to the top of the stack.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-discard.xml b/gpsbabel/xmldoc/filters/options/stack-discard.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..a4765b69d5ba1e7eb54ad8aa5ba7ba5dba162e83 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-discard.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-discard.xml
@@ -1 +1,5 @@
-
+<para>
+This option is only valid when used with the <option>pop</option> option.
+When this option is specified, the popped state is discarded and the current
+state remains unchanged.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-pop.xml b/gpsbabel/xmldoc/filters/options/stack-pop.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..0bfb7166005fc0966676526819b8cc138109b132 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-pop.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-pop.xml
@@ -1 +1,9 @@
-
+<para>
+This is one of three "primary" options to the stack filter.
+</para>
+<para>
+This option "pops" the collection of data from the top of the stack.  
+By default, the saved state replaces the current state, but see the 
+<option>discard</option> and <option>append</option> options for 
+alternatives.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-push.xml b/gpsbabel/xmldoc/filters/options/stack-push.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..8f76ad567434152c7225ca551abc9972a591449b 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-push.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-push.xml
@@ -1 +1,8 @@
-
+<para>
+This is one of three "primary" options to the stack filter.
+</para>
+<para>
+When this option is specified, the current state is pushed onto the top of
+the stack.  By default, the current state is then cleared, but the 
+<option>copy</option> option can be used to cause it to be saved.
+</para>

diff --git a/gpsbabel/xmldoc/filters/options/stack-replace.xml b/gpsbabel/xmldoc/filters/options/stack-replace.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..2e967fdba62339a63d0891d47ed55eabf8fa33ff 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-replace.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-replace.xml
@@ -1 +1,8 @@
+<para>
+This option is only valid when used with the <option>pop</option> option.
+This is the default behavior of the <option>pop</option> option, so you 
+should never need to specify it, but it is included for the sake of 
+readability.  When this option is specified, the popped state replaces 
+the current state.
+</para>
 

diff --git a/gpsbabel/xmldoc/filters/options/stack-swap.xml b/gpsbabel/xmldoc/filters/options/stack-swap.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..b9687445670443e3855fe8110cc94bb6873b1525 100644 (file)
--- a/gpsbabel/xmldoc/filters/options/stack-swap.xml
+++ b/gpsbabel/xmldoc/filters/options/stack-swap.xml
@@ -1 +1,10 @@
+<para>
+This is one of three "primary" options to the stack filter.
+</para>
+<para>
+When this option is specified, the current state is swapped with a saved
+state from the stack.  By default, it is swapped with the top of the stack,
+but the <option>depth</option> can be used to specify a different saved
+state.
+</para>
 

diff --git a/gpsbabel/xmldoc/filters/stack.xml b/gpsbabel/xmldoc/filters/stack.xml
index 98c2b963fa3cde0726504d612c8e6f187b318985..45934ad15ee2f5fb5167d2eaf103a324707fb7b7 100644 (file)
--- a/gpsbabel/xmldoc/filters/stack.xml
+++ b/gpsbabel/xmldoc/filters/stack.xml
@@ -1,55 +1,25 @@
-
-         
-         <para> This filter is designed to solve advanced problems
-         that involve shuffling multiple lists of waypoints.  It has
-         three distinct sets of suboptions:</para>
-         <para>PUSH</para>
-         <para>Pushes the current list of waypoints onto the stack.
-         If the 'copy' suboption is specified, a copy of the current
-         list is pushed onto the stack; otherwise, the current list is
-         cleared.</para>
-         <screen format="linespecific">
--x stack,push
--x stack,push,copy
-</screen>
-         <para>POP</para>
-         <para> 'Pops' the top list of waypoints off of the stack.
-         What is done with that list depends on the suboption
-         specified.  If the 'append' suboption is specified, the top
-         list of waypoints from the stack is added to the end of the
-         current list of waypoints.  If the 'discard' option is
-         specified, the top list of waypoints is removed from the
-         stack and discarded, leaving the current list of waypoints
-         unchanged.  If the 'replace' option is specified, or if no
-         option is specified, the top list of waypoints from the stack
-         replaces the current list of waypoints; the previous contents
-         of the current list are discarded.</para>
-         <screen format="linespecific">
--x stack,pop 
--x stack,pop,discard
--x stack,pop,append
-</screen>
-         <para>SWAP</para>
-         <para> Swaps the current list of waypoints with a list from
-         the stack.  If no further options are specified, the current
-         list is swapped with the top list on the stack.  If the
-         'depth' option is specified, it indicates which item on the
-         stack should be swapped.  </para>
-         <screen format="linespecific">
--x stack,swap        
--x stack,swap,depth=2 
-</screen>
-         <para> The stack can be used in conjunction with other
-         filters to implement a "union" or "logical or" functionality.
-         The basic idea is to use the stack to store copies of the
-         original list of waypoints, then use the 'swap' function to
-         replace each copy with a filtered list.  Finally, append all
-         of the filtered lists to create one big list, which is then
-         output.  The following example finds a list of all points
-         that are either inside county A or inside county B.  Any
-         points that are inside both counties are duplicated (but the
-         duplicates can be removed with the DUPLICATE filter; see
-         above.)
+<para> 
+This filter is designed to solve advanced problems that involve shuffling 
+multiple lists of waypoints, tracks, or routes.  
+</para>
+<para>
+The stack filter can be used to save the current state of the entire
+collection of data.  That state is placed on top of a stack of collections,
+so you can simultaneously have as many stored collections of data as you
+can fit in your computer's memory.
+</para>
+<para> 
+ The stack filter can be used in conjunction with other
+ filters to implement a "union" or "logical or" functionality.
+ The basic idea is to use the stack to store copies of the
+ original list of waypoints, then use the 'swap' function to
+ replace each copy with a filtered list.  Finally, append all
+ of the filtered lists to create one big list, which is then
+ output.  The following example finds a list of all points
+ that are either inside county A or inside county B.  Any
+ points that are inside both counties are duplicated (but the
+ duplicates can be removed with the DUPLICATE filter; see
+ above.)
 </para>
          <screen format="linespecific">           
 gpsbabel -i gpx -f in.gpx \
@@ -75,6 +45,5 @@ gpsbabel -i gpx -f indiana.gpx \
          -o palmdoc,dbname=Indianapolis -F indianapolis.pdb \
          -x stack,pop,append \
          -o magellan -F fwaind.wpt
- 
 </screen>